/*
 * MIT License
 * 
 * Copyright (c) 2017 wen.gu <454727014@qq.com>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: vos_mutex.h
 *
 * Purpose: virtual os layer mutex lock interface 
 *
 * Developer:
 *   wen.gu , 2015-10-10
 *
 * Note: this mutex lock only valid in process inner,cann't use to inter process
 * TODO: 
 *
 ***************************************************************************/

#ifndef __VOS_MUTEX_H__
#define __VOS_MUTEX_H__

#include "general_type.h"

#ifdef __cplusplus
extern "C"{
#endif
/***************************************************************************
 *
 * data struct declaration
 *
 ***************************************************************************/

/***************************************************************************
 *
 * mutex lock API declaration
 *
 ***************************************************************************/
/**
*@brief  create a mutex lock instance
*
*@param  None.
*
*@return if success return mutex lock intstance, else return 'NULL'.
*@see 
*/
G_API GPHD  vosMutexCreate(void);

/**
*@brief  free a mutex lock instance
*
*@param  mutex [in] a mutex lock instance handle.
*
*@return None.
*@see 
*/
G_API void  vosMutexFree(GPHD mutex);

/**
*@brief  lock on
*
*@param  mutex [in] a mutex lock instance handle.
*
*@return None.
*@see 
*/
G_API void  vosMutexLock(GPHD mutex);

/**
*@brief  lock off
*
*@param  mutex [in] a mutex lock instance handle.
*
*@return None.
*@see 
*/
G_API void vosMutexUnlock(GPHD mutex);

#ifdef __cplusplus
}
#endif

#endif //end of __VOS_MUTEX_H__
